Getting Started with PCC > Configuration > Configuring Log File Locations |
The Prizm Platform Services are made up of several different processes, each of which create and maintain their own logs. The logs are invaluable for diagnosing issues with the services if they arise. If you find yourself in this situation, please see the topic How to Package Log Files for Product Support to expedite your support request.
Each logging process has a default log file path that you can change if needed. This topic will discuss each process one by one and explain how to configure where log files are written.
This section contains the following information:
The Watchdog uses the following default log file paths:
The Watchdog will only keep up to 7 days of log files. To change where the Watchdog log files are written:
Example |
Copy Code
|
---|---|
"paths": { ... "app_log_dir": [ "C:/some/custom/path" ], ... }, |
The Server and Cloud Entry Points uses the following default log file paths:
The Entry Points will only keep up to 7 days of log files. To change where the Entry Points log files are written:
Example |
Copy Code
|
---|---|
"logging": { "logFilePath": "%ALLUSERSPROFILE%/Accusoft/Prizm/Logs/plb.log", "level": "info", "count": 7, "period": "1d" }, |
The PCCIS service uses the following default log file paths:
The PCCIS service will only keep up to 7 days of log files. To change where the PCCIS service log file are written:
Example |
Copy Code
|
---|---|
<target … fileName="C:/some/custom/path/ImagingServices.log" archiveFileName="C:/some/custom/path/ImagingServices-{#}.log" … /> |
The PDF Conversion Service uses the following default log file paths:
The PDF Conversion Service will only keep up to 7 days of log files. To change where the PDF Conversion Service log files are written:
Example |
Copy Code
|
---|---|
{ ... "logFileLocation": "C:/some/custom/path/PDFConversionService.log", ... } |
The Raster Conversion Service uses the following default log file paths:
The Raster Conversion Service will only keep up to 7 days of log files. To change where the Raster Conversion Service log files are written:
Example |
Copy Code
|
---|---|
{ ... "logFileLocation": "C:/some/custom/path/RasterConversionService.log", ... } |
The Office Conversion Service uses the following default log file paths:
The Office Conversion Service will only keep up to 7 days of log files. To change where the Office Conversion Service log files are written:
Example |
Copy Code
|
---|---|
{ ... "logFileLocation": "C:/some/custom/path/OfficeConversionService.log", ... } |
The Error Reporting Service uses the following default log file paths:
The Error Reporting Service will only keep up to 7 days of log files. To change where the Error Reporting Service log files are written:
Example |
Copy Code
|
---|---|
{ ... "errorReportingService": { "logging": { "logFilePath": "%ALLUSERSPROFILE%/Accusoft/Prizm/Logs/ErrorReportingService.log", ... }, }, ... } |
The Proxy Server Service uses the following default log file paths:
The Proxy Server Service will only keep up to 7 days of log files. To change where the Raster Conversion Service log files are written:
Example |
Copy Code
|
---|---|
jrunner.logfile=C:/some/custom/path/proxyserver-YYYYMMDD.log"
|
If you run PCC on Linux, Nginx is used to host the HTTP API for PCCIS. The proper version of Nginx is included with the product and set up for you during installation, but we do not change the default Nginx logging rules.
On a production machine, you will want to configure:
Nginx offers some basic logging features commonly found in web servers such as enabling logs to record access and error history, as well as the ability to adjust the format of the content written to the logs.
PCC enables both the access log and error log for Nginx. You can adjust where these logs are stored by editing this config file:
Example |
Copy Code
|
---|---|
/usr/share/prizm/nginx/nginx.conf |
In this file, you can assign the paths you want for the error_log and access_log. In the excerpt below, you would alter the two paths which appear after error_log and access_log:
Example |
Copy Code
|
---|---|
error_log /usr/share/prizm/nginx/logs/error.log warn; … log_format main '$remote_addr - $remote_user [$time_local] "$request" ' '$status $body_bytes_sent "$http_referer" ' '"$http_user_agent" "$http_x_forwarded_for" $request_time'; access_log /usr/share/prizm/nginx/logs/access.log main; … |
For more information about Nginx logging, please see the Nginx docs for the log module.
By default, Nginx will continue writing to a single access log and a single error log for its entire lifetime. Over time these logs can grow very large to a point where they start consuming a significant about of storage space.
Fortunately, most Linux distributions include a utility called logrotate to help with this problem. PCC includes a logrotate configuration that will cause the Nginx access and error logs to be rotated daily, with the old logs being GZIP compressed and automatically deleted after 7 days. The logrotate configuration that PCC provides can be found in the following file:
Example |
Copy Code
|
---|---|
/etc/logrotate.d/prizm |
You may edit the file if you would like to adjust the log rotation settings for Nginx. See the logrotate man page for more information about available logrotate settings and their meanings.